Add details about rate limits for Operator deployments#2748
Conversation
Document the rate limits listed in https://www.notion.so/wandbai/Rate-Limits-74e0c3a60b11443b8582610a8bbb2f2c?source=copy_link except for GORILLA_LIMITER and *ARTIFACTS* Fixes DOCS-2575
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
📚 Mintlify Preview Links📝 Changed (3 total)📄 Pages (3)
🤖 Generated automatically when Mintlify deployment succeeds |
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-docs-2575.mintlify.app |
HiveMind Sessions1 session · 1m · $0.00
|
There was a problem hiding this comment.
Pull request overview
Adds Operator-specific documentation for configuring rate limits via environment variables, and updates the Self-Managed and Dedicated Cloud rate-limit pages to link to the new configuration section.
Changes:
- Added a “Set rate limits” section to the Kubernetes Operator docs, including a YAML example and env-var table.
- Updated Self-Managed and Dedicated Cloud rate-limit pages to link readers to the Operator rate-limit configuration section.
- Refined support guidance wording on rate-limit pages.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| platform/hosting/self-managed/rate-limits.mdx | Updates the guidance paragraph to point to the new Operator “Set rate limits” section. |
| platform/hosting/self-managed/operator.mdx | Adds new “Set rate limits” section with YAML example and an env-var reference table. |
| platform/hosting/hosting-options/dedicated-cloud/rate-limits.mdx | Adds a link to the Operator “Set rate limits” section in the recommended-defaults guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| For Dedicated Cloud and Self-Managed deployments that use the Operator, optionally configure rate limits by setting environment variables in `spec.values.global.extraEnv`. This example shows the default value when the variable is not set. | ||
|
|
||
| <Important>You must set `GORILLA_LIMITER` to the address of your Redis server.</Important> |
|
|
||
| ### Set rate limits | ||
|
|
||
| For Dedicated Cloud and Self-Managed deployments that use the Operator, optionally configure rate limits by setting environment variables in `spec.values.global.extraEnv`. This example shows the default value when the variable is not set. |
| GORILLA_DEFAULT_RATE_LIMITS_GRAPHQL: "50" | ||
| GORILLA_DEFAULT_RATE_LIMITS_RUN_UPDATE_COUNT: "10" | ||
| GORILLA_DEFAULT_RATE_LIMITS_SDK_GRAPHQL_QUERY_SECONDS: "1" | ||
| GORILLA_LIMITER: "redis://[redis-service-address]:6379?ttlInSeconds=900" |
| | Environment variable | Default | Description | | ||
| | --- | --- | --- | | ||
| | `GORILLA_DEFAULT_RATE_LIMITS_FILESTREAM` | `5` | Default filestream requests. | | ||
| | `GORILLA_DEFAULT_RATE_LIMITS_FILESTREAM_COUNT` | `5` | Filestream requests per second. | | ||
| | `GORILLA_DEFAULT_RATE_LIMITS_FILESTREAM_PER_RUN_COUNT` | `0.8` | Filestream requests per per run per second. | | ||
| | `GORILLA_DEFAULT_RATE_LIMITS_FILESTREAM_SIZE` | `10` | Filestream ingestion limit in MB per second. | | ||
| | `GORILLA_DEFAULT_RATE_LIMITS_GRAPHQL` | `50` | GraphQL requests. | | ||
| | `GORILLA_DEFAULT_RATE_LIMITS_RUN_UPDATE_COUNT` | `10` | Run metadata update requests per second. | | ||
| | `GORILLA_DEFAULT_RATE_LIMITS_SDK_GRAPHQL_QUERY_SECONDS` | `1` | SDK GraphQL query seconds budget. | |
| GORILLA_DEFAULT_RATE_LIMITS_FILESTREAM_SIZE: "10" | ||
| GORILLA_DEFAULT_RATE_LIMITS_GRAPHQL: "50" | ||
| GORILLA_DEFAULT_RATE_LIMITS_RUN_UPDATE_COUNT: "10" | ||
| GORILLA_DEFAULT_RATE_LIMITS_SDK_GRAPHQL_QUERY_SECONDS: "1" |
There was a problem hiding this comment.
I would maybe remove the GORILLA_DEFAULT_RATE_LIMITS_SDK_GRAPHQL_QUERY_SECONDS and GORILLA_DEFAULT_RATE_LIMITS_GRAPHQL from the recommendation since we don't set these on dedicated by default.
Description
Add details about rate limits for Operator deployments
Document the rate limits listed in
https://www.notion.so/wandbai/Rate-Limits-74e0c3a60b11443b8582610a8bbb2f2c?source=copy_link except for
*ARTIFACT*.Fixes DOCS-2575
Testing
mint dev)mint broken-links)